Conversation
saragerion
left a comment
There was a problem hiding this comment.
Shall we add "safety nets" in at the beginning of this flow to make sure that only stable, safe code is published?
For example:
- Linting
- npm audit
- Unit tests
What do you think?
…ertools-typescript into chore/releaseFlow
|
Will open a new one with better way of handling |
…ertools-typescript into chore/releaseFlow
| You can build and start a local docs website by running these two commands. | ||
| - `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/` | ||
| - `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material` | ||
|
|
There was a problem hiding this comment.
Can you add a section on all the steps that need to be done to successfully create a release?
For instance: was the changelog generated automatically? Anything manually we need to do?
There was a problem hiding this comment.
no manual step needed. all done automatically. only constraint already mention in doc is follow semantic pull requests
| // Import the library | ||
| import { Logger } from '../src'; | ||
| // When going public, it will be something like: import { Logger } from '@aws-lambda-powertools/logger'; | ||
| // When going public, it will be something like: import { Logger } from '@flochaz/logger'; |
There was a problem hiding this comment.
oops? I guess it should be @aws-lambda-powertools?
| "main": "./lib/packages/metrics/src/index.js", | ||
| "types": "./lib/packages/metrics/src/index.d.ts", | ||
| "main": "./lib/index.js", | ||
| "types": "./lib/index.d.ts", |
saragerion
left a comment
There was a problem hiding this comment.
LGTM. Let's remember to add auditing, linting and tests check in the on-release workflow before making this repo public
805b1be to
d2805e6
Compare
Description of your changes
How to verify this change
Ran in provate repo:
https://github.com/flochaz/aws-lambda-powertools-typescript/releases
Output:
0.1.0-beta.0 (2021-12-06)
Bug Fixes
Features
Related issues, RFCs
#136
PR status
Is this ready for review?: NO
Is it a breaking change?: NO
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.